ugp.org.SerialX

Class Scope

java.lang.Object

ugp.org.SerialX.Scope

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<java.lang.Object>

public class Scope
extends java.lang.Object
implements java.lang.Iterable<java.lang.Object>, java.lang.Cloneable

This is some kind of hybrid between List and Map which allow you to have both variables and independent values managed by one Object.
Note: Variables are managed and accessed classically via Map methods such as put(String key, Object) and array of independent values is accessed by via List methods such as add(Object) and get(int)
This is used internally by Serializer and supposed to be read only!
Also this is java representation of SerialX Scope group such as:

 
 {
     //This is scope in SerialX!
 }
 
 

Author:

PETO

Constructor Summary

Constructors

Constructor and Description
Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap, java.util.Collection<java.lang.Object> values)
Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap, java.lang.Object... values)
Scope(java.lang.Object... values)

Method Summary

Modifier and Type	Method and Description
Scope	clone()
boolean	containsIndependentValue(java.lang.Object value)
boolean	containsVariable(java.lang.String variableName)
<T> T	get(int valueIndex)
<T> T	get(java.lang.String variableName)
Scope	getParent()
Scope	getScope(int scopesOrderIndex)
Scope	getScope(java.lang.String... scopesPath)
Scope	getScopeAt(int scopeValueIndex)
boolean	isEmpty()
java.util.Iterator<java.lang.Object>	iterator()
java.lang.String	toString()
java.lang.Object[]	toValArray()
java.util.List<java.lang.Object>	toValList()
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	toVarMap()
int	valuesCount()
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	varEntrySet()
int	variablesCount()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Scope

@SafeVarargs
public Scope(java.lang.Object... values)

Parameters:

values - | Initial independent values to be added in to this scope!

Since:

1.2.0

Scope

@SafeVarargs
public Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap,
                           java.lang.Object... values)

Parameters:

variablesMap - | Initial variables to be added in to this scope!

values - | Initial independent values to be added in to this scope!

Since:

1.2.0

Scope

public Scope(java.util.Map<java.lang.String,java.lang.Object> variablesMap,
             java.util.Collection<java.lang.Object> values)

Parameters:

variablesMap - | Initial variables to be added in to this scope!

values - | Initial independent values to be added in to this scope!

Since:

1.2.0

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public Scope clone()

Overrides:

clone in class java.lang.Object

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Object>

Returns:

Iterator of independent values.

Since:

1.2.0

get

public <T> T get(java.lang.String variableName)

Parameters:

variableName - | Variables name.

Returns:

Value of variable with name or null if there is no such a one!

Since:

1.2.0

containsVariable

public boolean containsVariable(java.lang.String variableName)

Parameters:

variableName - | Variables name to search for.

Returns:

True if variable with given name was found in this scope.

Since:

1.2.0

containsIndependentValue

public boolean containsIndependentValue(java.lang.Object value)

Parameters:

value - | Objecthe value.

Returns:

True if independent value was found in this scope.

Since:

1.2.0

get

public <T> T get(int valueIndex)

Parameters:

valueIndex - | Index of independent value. Also can be negative, in this case u will get elements from back!

Returns:

Independent value.

Since:

1.2.0

getScopeAt

public Scope getScopeAt(int scopeValueIndex)

Parameters:

scopeValueIndex - | Index of sub-scopes value.

Returns:

Sub-scope on required index or null if there is no scope on required index!
Note: Keep in mind that you need to insert valid index according to other values. Scopes share same index order with other values!

Since:

1.2.0

getScope

public Scope getScope(int scopesOrderIndex)

Parameters:

scopesOrderIndex - | Order index of sub-scope.

Returns:

Sub-scope with required number. Similar to getScopeAt(int) however this will ignore non scope variables.

For instance getScope(1) in context:

 
 variable = "something";
 "something";
 {
      "Scope0"
 };
 123;
 null;
 {
      "Scope1" <- This one will be returned!

 };
 4;
 5;
 6;
 {
      "Scope2"
 }
 
 

Since:

1.2.0

getScope

public Scope getScope(java.lang.String... scopesPath)

Parameters:

scopesPath - | Array with variable names creating path to required scope.

Returns:

Sub-scope stored by variable with required name (last element) in inserted path or null if there is no such a one in inserted path. If there is more than one result, the first one found will be returned! This search will also includes sub-scopes of scope but variables from lower ones are prioritize!
If this function is called with no arguments then self will be returned!

 
 variable = "something";
 scope1 = 
 {
      subScope = 
      {
          scopeObjectoFind = {...}; <- this one will be returned if getScope("scope1", "scopeObjectoFind") is issued!
          7;...
      }
 };
 scopeObjectoFind = {...} <- this one will be returned if getScope("scopeObjectoFind") is issued!
 
 

Note: Remember that this search includes variables only, no values!

Since:

1.2.0

varEntrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> varEntrySet()

Returns:

Entry set of variables!

Since:

1.2.0

valuesCount

public int valuesCount()

Returns:

Count of keyless values of this scope!

Since:

1.2.0

variablesCount

public int variablesCount()

Returns:

Count of variables!

Since:

1.2.0

isEmpty

public boolean isEmpty()

Returns:

True if this scope is completely empty, meaning there are no variables or values.

Since:

1.2.0

getParent

public Scope getParent()

Returns:

The parent scope of this scope or null if this scope has no parent such as default one in file.

Since:

1.2.0

toVarMap

public java.util.LinkedHashMap<java.lang.String,java.lang.Object> toVarMap()

Returns:

LinkedHashMap with variables of this Scope in defined order! Key is a string name of variable and value is its value!
Modifying this map will not affect this Scope object!

Since:

1.2.0

toValList

public java.util.List<java.lang.Object> toValList()

Returns:

ArrayList with independent values of this Scope. These values have nothing to do with values of variables, they are independent! Modifying this list will not affect this Scope object!

Since:

1.2.0

toValArray

public java.lang.Object[] toValArray()

Returns:

Primitive array with independent values of this Scope. These values have nothing to do with values of variables, they are independent! Modifying this list will not affect this Scope object!

Since:

1.2.0